<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>ray.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_vec_ray.js.html">ray.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2011 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Implements a 3D ray that are compatible with WebGL.
<a name="line17"></a> * Each element is a float64 in case high precision is required.
<a name="line18"></a> * The API is structured to avoid unnecessary memory allocations.
<a name="line19"></a> * The last parameter will typically be the output vector and an
<a name="line20"></a> * object can be both an input and output parameter to all methods
<a name="line21"></a> * except where noted.
<a name="line22"></a> *
<a name="line23"></a> */
<a name="line24"></a>goog.provide(&#39;goog.vec.Ray&#39;);
<a name="line25"></a>
<a name="line26"></a>goog.require(&#39;goog.vec.Vec3&#39;);
<a name="line27"></a>
<a name="line28"></a>
<a name="line29"></a>
<a name="line30"></a>/**
<a name="line31"></a> * Constructs a new ray with an optional origin and direction. If not specified,
<a name="line32"></a> * the default is [0, 0, 0].
<a name="line33"></a> * @param {goog.vec.Vec3.AnyType=} opt_origin The optional origin.
<a name="line34"></a> * @param {goog.vec.Vec3.AnyType=} opt_dir The optional direction.
<a name="line35"></a> * @constructor
<a name="line36"></a> */
<a name="line37"></a>goog.vec.Ray = function(opt_origin, opt_dir) {
<a name="line38"></a>  /**
<a name="line39"></a>   * @type {goog.vec.Vec3.Number}
<a name="line40"></a>   */
<a name="line41"></a>  this.origin = goog.vec.Vec3.createNumber();
<a name="line42"></a>  if (opt_origin) {
<a name="line43"></a>    goog.vec.Vec3.setFromArray(this.origin, opt_origin);
<a name="line44"></a>  }
<a name="line45"></a>
<a name="line46"></a>  /**
<a name="line47"></a>   * @type {goog.vec.Vec3.Number}
<a name="line48"></a>   */
<a name="line49"></a>  this.dir = goog.vec.Vec3.createNumber();
<a name="line50"></a>  if (opt_dir) {
<a name="line51"></a>    goog.vec.Vec3.setFromArray(this.dir, opt_dir);
<a name="line52"></a>  }
<a name="line53"></a>};
<a name="line54"></a>
<a name="line55"></a>
<a name="line56"></a>/**
<a name="line57"></a> * Sets the origin and direction of the ray.
<a name="line58"></a> * @param {goog.vec.AnyType} origin The new origin.
<a name="line59"></a> * @param {goog.vec.AnyType} dir The new direction.
<a name="line60"></a> */
<a name="line61"></a>goog.vec.Ray.prototype.set = function(origin, dir) {
<a name="line62"></a>  goog.vec.Vec3.setFromArray(this.origin, origin);
<a name="line63"></a>  goog.vec.Vec3.setFromArray(this.dir, dir);
<a name="line64"></a>};
<a name="line65"></a>
<a name="line66"></a>
<a name="line67"></a>/**
<a name="line68"></a> * Sets the origin of the ray.
<a name="line69"></a> * @param {goog.vec.AnyType} origin the new origin.
<a name="line70"></a> */
<a name="line71"></a>goog.vec.Ray.prototype.setOrigin = function(origin) {
<a name="line72"></a>  goog.vec.Vec3.setFromArray(this.origin, origin);
<a name="line73"></a>};
<a name="line74"></a>
<a name="line75"></a>
<a name="line76"></a>/**
<a name="line77"></a> * Sets the direction of the ray.
<a name="line78"></a> * @param {goog.vec.AnyType} dir The new direction.
<a name="line79"></a> */
<a name="line80"></a>goog.vec.Ray.prototype.setDir = function(dir) {
<a name="line81"></a>  goog.vec.Vec3.setFromArray(this.dir, dir);
<a name="line82"></a>};
<a name="line83"></a>
<a name="line84"></a>
<a name="line85"></a>/**
<a name="line86"></a> * Returns true if this ray is equal to the other ray.
<a name="line87"></a> * @param {goog.vec.Ray} other The other ray.
<a name="line88"></a> * @return {boolean} True if this ray is equal to the other ray.
<a name="line89"></a> */
<a name="line90"></a>goog.vec.Ray.prototype.equals = function(other) {
<a name="line91"></a>  return other != null &amp;&amp;
<a name="line92"></a>      goog.vec.Vec3.equals(this.origin, other.origin) &amp;&amp;
<a name="line93"></a>      goog.vec.Vec3.equals(this.dir, other.dir);
<a name="line94"></a>};
</pre>


</body>
</html>
